com.highdeal.bart.hci
Class InvalidRatingSessionException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.highdeal.hci.OperationFailureException
              extended by com.highdeal.bart.hci.InvalidRatingSessionException
All Implemented Interfaces:
com.highdeal.hci.OperationResult, XMLMarshallable, java.io.Serializable

public class InvalidRatingSessionException
extends com.highdeal.hci.OperationFailureException

This class implements the methods for the description of an invalid rating session exception.

See Also:
Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="invalidRatingSessionFault">
   <xs:complexType>
     <xs:attribute name="reason" type="InvalidRatingSessionReasonType"/>
     <xs:attribute name="message" type="xs:string"/>
   </xs:complexType>
 </xs:element>
<xs:simpleType name="InvalidRatingSessionReasonType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="internalError"/>
     <xs:enumeration value="sessionDoesNotExist"/>
     <xs:enumeration value="sessionIsNull"/>
     <xs:enumeration value="sessionIsAlreadyEnded"/>
     <xs:enumeration value="invalidRatingMode"/>
     <xs:enumeration value="nullBatchRatingGroupId"/>
     <xs:enumeration value="nullMaxConsumptionDate"/>
     <xs:enumeration value="sessionAlreadyRunning"/>
     <xs:enumeration value="tooManyRunningSessions"/>
     <xs:enumeration value="stoppingRunningSessions"/>
     <xs:enumeration value="notRunning"/>
   </xs:restriction>
 </xs:simpleType>


Field Summary
static int INTERNAL_ERROR
          Reserved for internal use.
static int INVALID_RATING_MODE
          The rating mode is invalid.
static int NULL_BATCH_RATING_GROUP_ID
          The batch rating group id is null.
static int NULL_MAX_CONSUMPTION_DATE
          The max consumption date is null.
static int NULL_RATING_SESSION
          The given rating session id is null.
static int RATING_SESSION_ALREADY_ENDED
          The rating session is already ended.
static int RATING_SESSION_ALREADY_RUNNING
          The rating session is already running.
static int RATING_SESSION_DOES_NOT_EXIST
          The rating session doesn't exist.
static int RATING_SESSION_NOT_RUNNING
          The rating session is not running.
static int STOPPING_RUNNING_SESSIONS
          There is no rating session to stop.
static int TOO_MANY_RUNNING_SESSIONS
          It is not possible a new rating session because there too many rating session running.
 
Constructor Summary
InvalidRatingSessionException()
          Builds an empty InvalidRatingException.
InvalidRatingSessionException(int reason)
          Builds an InvalidRatingException.
InvalidRatingSessionException(int reason, java.lang.String operandReference)
          Builds an InvalidAcquisitionException.
 
Method Summary
 void addCharacterData(java.lang.String cData)
          Adds character data to the content element.
 void addChild(java.lang.String tagName, XMLMarshallable child)
          Adds a child to the object, the child representing the marshallable object which must be added to the element.
 java.lang.String getMessage()
          Gets the message.
 java.lang.String getOperandReference()
           
 int getReason()
          Returns the reason of the exception.
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, including its children.
static java.lang.String reasonToString(int r)
           
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the element being processed.
 java.lang.String toString()
          Returns the reason of the exception in readable format.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INTERNAL_ERROR

public static final int INTERNAL_ERROR
Reserved for internal use.

See Also:
Constant Field Values

RATING_SESSION_DOES_NOT_EXIST

public static final int RATING_SESSION_DOES_NOT_EXIST
The rating session doesn't exist.

See Also:
Constant Field Values

NULL_RATING_SESSION

public static final int NULL_RATING_SESSION
The given rating session id is null.

See Also:
Constant Field Values

RATING_SESSION_ALREADY_ENDED

public static final int RATING_SESSION_ALREADY_ENDED
The rating session is already ended.

See Also:
Constant Field Values

INVALID_RATING_MODE

public static final int INVALID_RATING_MODE
The rating mode is invalid.

See Also:
Constant Field Values

NULL_BATCH_RATING_GROUP_ID

public static final int NULL_BATCH_RATING_GROUP_ID
The batch rating group id is null.

See Also:
Constant Field Values

NULL_MAX_CONSUMPTION_DATE

public static final int NULL_MAX_CONSUMPTION_DATE
The max consumption date is null.

See Also:
Constant Field Values

RATING_SESSION_ALREADY_RUNNING

public static final int RATING_SESSION_ALREADY_RUNNING
The rating session is already running.

See Also:
Constant Field Values

TOO_MANY_RUNNING_SESSIONS

public static final int TOO_MANY_RUNNING_SESSIONS
It is not possible a new rating session because there too many rating session running.

See Also:
Constant Field Values

STOPPING_RUNNING_SESSIONS

public static final int STOPPING_RUNNING_SESSIONS
There is no rating session to stop.

See Also:
Constant Field Values

RATING_SESSION_NOT_RUNNING

public static final int RATING_SESSION_NOT_RUNNING
The rating session is not running.

See Also:
Constant Field Values
Constructor Detail

InvalidRatingSessionException

public InvalidRatingSessionException()
Builds an empty InvalidRatingException.


InvalidRatingSessionException

public InvalidRatingSessionException(int reason)
Builds an InvalidRatingException.

Parameters:
reason - the reason of the exception.

InvalidRatingSessionException

public InvalidRatingSessionException(int reason,
                                     java.lang.String operandReference)
Builds an InvalidAcquisitionException.

Parameters:
reason - the reason of the exception.
operandReference - an operand reference such as faultly CDR OID.
Method Detail

getReason

public int getReason()
Returns the reason of the exception.

Returns:
the reason of the exception.

getOperandReference

public java.lang.String getOperandReference()
Specified by:
getOperandReference in interface com.highdeal.hci.OperationResult
Overrides:
getOperandReference in class com.highdeal.hci.OperationFailureException

toString

public java.lang.String toString()
Returns the reason of the exception in readable format.

Overrides:
toString in class java.lang.Throwable
Returns:
a string describing the reason of the exception.

getMessage

public java.lang.String getMessage()
Gets the message.

Overrides:
getMessage in class java.lang.Throwable
Returns:
the message.

setAttributes

public void setAttributes(XMLAttributes atts)
Description copied from interface: XMLMarshallable
Sets the attributes of the XML representation of the element being processed.

Parameters:
atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)
Description copied from interface: XMLMarshallable
Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:
tagName - The name of tag for the child
child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)
Description copied from interface: XMLMarshallable
Adds character data to the content element.

Parameters:
cData - The character data to be added

marshal

public void marshal(XMLOutputter output)
Description copied from interface: XMLMarshallable
Gives an XML representation of this object, including its children.

Parameters:
output - The XML output to marshal the object into

reasonToString

public static java.lang.String reasonToString(int r)

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)